home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 5 / Amiga Tools 5.iso / tools / wb-tools / background / background.doc < prev    next >
Text File  |  1996-03-17  |  6KB  |  206 lines
  1. Document Background
  2.  
  3.                                     Background v1.32
  4.  
  5. Background and this text are copyright © 1996 Roland Haas
  6.  
  7.  
  8. 1. Copyright&disclaimer
  9. =======================
  10.  
  11. Copying
  12.  
  13. Background may bee sold freely, as long as the contents of this archive is
  14. spread completely. There may be raised no charge other than a fee for copying.
  15.  
  16. Background may be sold with other free redistributable software, as long as the
  17. conditions above are satisfied. This program may only be included in a
  18. commercial package if you have the written permission of the `author'.
  19.  
  20. Disclaimer
  21.  
  22. This product is sold "AS IS" without representation or warranty of any kind,
  23. either expressed or implied.
  24.                   YOU USE THIS PROGRAMM ON YOUR OWN RISK
  25.  
  26. 2. Introduction
  27. ===============
  28.  
  29. What is "Background"?
  30.  
  31. Background is a program similar NickPrefs by Nicola Salmoria. Unlike NickPrefs'
  32. WBPICTURE every workbench window can be connected with its own picture.
  33.  
  34. Why?
  35.  
  36. Background has been written, because at that time I did not have the
  37. opportunity of getting NickPrefs. As I finally had NickPrefs, the possibilities
  38. offered did not satisfy me. Because I did not know, whether there was a similar
  39. program I decided to write my own.
  40.  
  41. 3. Requirements
  42. ===============
  43.  
  44. Necessary are:
  45.  
  46.  · at least OS 2.0
  47.  · IFFPARSE.library in LIBS:
  48.  
  49. Not necessary, but recommended are:
  50.  
  51.  · 1 MBYTE Chip-RAM
  52.  · hard-disk
  53.  
  54. 4. Installation
  55. ===============
  56.  
  57. First you should copy the program Background to the WBSTARTUP drawer. Then
  58. start a text-editor and edit the file "ENVARC:Background.conf".
  59. (enter "ed envarc:Background.conf" in a shell)
  60. Information how to set up the file can be found in `Konfiguration'. After
  61. having created the file, you must either perform a reboot or copy the file from
  62. ENVARC: to ENV:
  63.  
  64.  
  65. 5. Konfiguration
  66. ================
  67.  
  68. Background gets information about the windows from the file ENV:Background.conf
  69. The OS has copied this file during booting from ENVARC: there. That means, that
  70. you, to make permanent modifications, will always have to edit the file in
  71. ENVARC: then you will have to copy it to ENV:. See also `Future'.
  72.  
  73.  
  74. 5.1. The file Background.conf
  75.  
  76. The file must have the following format:
  77.  
  78. First line    : path_to_a_picture,TILE/S
  79. Second line : path_to_a_picture,TILE/S
  80. other lines : path_to_a_picture,pattern,TILE/S
  81.  
  82.  
  83. Path_to_a_picture specifies the IFF-picture, that serves as the background.
  84.  
  85. If TILE is provided, then the picture will be used as a pattern, that will be
  86. repeated as long as necessary. Then the bottom edge must fit to the top one
  87. and the left to the right. If however TILE is omitted, all area not covered
  88. by the picture will be filled with the background color (grey).
  89.  
  90. The pattern is a DOS pattern, that specifies, for which windows the picture
  91. is to be used. Possible patterns are for example:
  92.  
  93. (Prefs|Presets)                     - the drawers Prefs and Presets
  94. Pictures.~(HAM)                     - all pictures. drawers except the drawers
  95.                                             Pictures.HAM
  96. "#? % full, #? free, #? in use"    - all disk windows
  97.  
  98. Note the quotes around the last pattern, they are needed, because the pattern
  99. contains spaces.
  100.  
  101. 5.2. Example
  102. ============
  103.  
  104. Work:gfx/Pix/Back1 TILE ;Standard picture
  105. Work:Gfx/Pix/Romantique ;Workbench window
  106. Work:Gfx/Pix/Disks "#? % full, #? free, #? in use" TILE ;All Disks
  107. Work:Gfx/Pix/Back2 (Prefs|Presets|Devs|System) TILE ;System drawers
  108.  
  109.  
  110. 5.1.1. The meaning of the lines
  111.  
  112. The lines have the following meaning:
  113.  
  114. Line 1 : specifies which picture is to be used, if none of the patterns fit.
  115.  
  116. Line 2 : This is not necessary needed. When it exists, it specifies which
  117.             picture to use, if the window does not have a title. This is true,
  118.             for example, for the main workbench window. If background.conf looks
  119.             like the following:
  120.  
  121.             dh0:Gfx/Pix/Back1 "#? % full, #? free, #? in use" TILE
  122.             dh0:Gfx/Pix/Game     #?Games#? TILE
  123.  
  124.             then, the windows "Games 50 % full, 24 M free, 24 M in use", will use
  125.             the picture "dh0:Gfx/pix/Game".
  126.  
  127. 6. Usage
  128. ========
  129.  
  130. Background can be used both from workbench and from the CLI. In both cases
  131. the keyword NOSCAN is accepted. This keyword prevents Background from scanning
  132. and changing the background of already opened windows.
  133.  
  134. CLI: background NOSCAN/S
  135. WB:  NOSCAN as a tooltype
  136.  
  137. 7. Future
  138. =========
  139.  
  140. included surely:
  141.  
  142.     · Preferences editor à la NickPrefs
  143.     · Changing the picture list without terminating the program
  144.  
  145. probably included:
  146.  
  147.     · reduced program size and memory consuming
  148.  
  149. Suggestions to the `author'.
  150.  
  151. 8. credits
  152. ==========
  153.  
  154. thanks to these people. Without them I would have never written this program.
  155.  
  156. David Benn : for his ACE compiler, with which the program was written. See also
  157.                  `history'.
  158.  
  159. My brother : No one finds as many errors ;-)
  160.  
  161. Nicola Salmoria : For the Nickprefs, that made me writing this program.
  162.  
  163. 9. Known bugs
  164. =============
  165.  
  166.     · very small pictures (<64{x}64) will crash the program
  167.       workaround: use DPAINT to duplicate the picture
  168.  
  169.     · no real bug: it is _not_ possible to remove a patch safely from the
  170.       system.
  171.  
  172.     · when Background is started before the workbench nothing will happen
  173.  
  174. 10. Author
  175. ==========
  176.  
  177.     Who wants to give a little Gift for his effort to a poor student, send
  178.     money, programs etc to :
  179.  
  180.  
  181.         Roland Haas
  182.         Mühlweg 16
  183.         77948 Friesenheim
  184.         Deutschland
  185.  
  186.         telephone: ++49 7821/68084
  187.  
  188. 11. history
  189. ===========
  190.  
  191. The beginnings of the program are unknown even to myself. All began in
  192. november '95, with a load routine for IFF-ILBM pictures. Here is the
  193. documented history since january '96:
  194.  
  195.  20.01.1996: V1.15 working version (yea, well nearly)
  196.  20.02.1996: V1.20 Mungwall-hit and other things
  197.  24.02.1996: V1.21 again a Mungwall-hit
  198.  25.02.1996: V1.25 MatchWin and TestHook now assemblers
  199.  05.03.1996: V1.30 ViewPic ported to assembler
  200.  09.03.1996: V1.31 minor bug in CleanExit
  201.  16.03.1996: V1.32 bug in recognizing caller task
  202.  
  203. Starting with V1.25 the routines, the of systems calls, are written in
  204. assembler. (A68k).
  205. Starting with V2.0 probably the whole program will be written in assembler.
  206.